VoiceFormウェブサービス

VoiceCheckはVoiceFormを作成することのできるWebサービスを提供します（データインポート）。このWebサービスでは、VoiceFormの作成や、VoiceCheckサーバにある既存のVoiceFormの更新や削除ができます。このWebサービスを起動すると、VoiceCheckは以下の点についてシステムを検証します：

一致するVoiceForm名がなければ、新しいVoiceFormが作成されます。
一致するVoiceForm名があれば、新しいVoiceFormは作成されません。

VoiceFormはVoiceFormステップありまたはなしでインポートできます。これにより技術者はVoiceFormステップを後で、VoiceCheckサーバから作成することができます。

VoiceCheckがVoiceFormの読み取り、更新、削除のメッセージを受け取るとき、次の条件が適用されます：

VoiceFormがVoiceCheckに存在しなければ、詳細は応答に返されません。
VoiceFormが存在する場合、WebサービスはVoiceFormの名前だけを更新できます。
VoiceFormがVoiceCheck内の他のエンティティで参照されていなければ、削除することができます。そうでない場合VoiceFormの削除は許可されません。

VoiceForm作成の詳細

REST Web サービス

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform

メソッド: POST

コンテンツタイプ: application/json;charset=UTF-8

メッセージ本文: WADLのスキーマで定められた通りのJSON。要素は入力要素テーブルに記載されています。

応答: 成功の場合、HTTP Status 200 、ペイロードは“VoiceForm saved”。失敗すると、システムはエラーを返します。 200または204以外のHTTPステータスコードはエラーと見なされます。可能な場合、ホストシステムはエラーに対して本文を返します。

POST パラメータ

本文に有効なパラメータを含むVoiceFormファイル。

VOICEFORM読み取りの詳細

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

メソッド: GET

コンテンツタイプ: application/json;charset=UTF-8

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

VoiceForm更新の詳細

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/update/{voiceformname}/{newvoiceformname}

メソッド: POST

コンテンツタイプ: application/json;charset=UTF-8

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

VoiceForm削除の詳細

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

メソッド: DELETE

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

画像管理

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/imageService?_wadl

URL: <http or https>://<VoiceCheckIP>:<port>/VoiceCheck/services/imageService/<Directory/Folder Name><Directory/Folder Name>.....<photo filename with extension>

メソッド: GET

パラメータ: ファイルシステム内の画像パスと画像名（パラメータはURL内で送信されます）

コンテンツタイプ: (blank)

応答: 成功の場合、HTTP Status 200。写真が見つからない場合、サービスは WebAppplicationException を HTTPステータス404 Not Foundで生成します。

基本認証: VoiceCheckユーザ名およびパスワード

入力要素

プロパティ	タイプ	必須	定義	検証
voiceformname	文字列	はい	VoiceFormの名前	VoiceCheck内で一意であること